wfm-ux
TMF622-GET-Retrieve Product Order Details
This operation allows to retrieve product order information based on provided inputs such as productOrderId, workOrderId and accountNumber.
Key Considerations for Liberate FTTH Implementation
- billingAccount.id queryParam (i.e. Billing Account Number) is mandatory to retrieve the product order details from Liberate.
- This is implemented for JM market.
- Based on the project management request, we have included the orderCharacteristics object in the response. While this approach deviates from TMF standards, it was implemented to minimize effort on the WFM side, allowing them to reuse their existing implementation.
- As per the standards, we are also displaying duplicate fields from the orderCharacteristics object under the place and relatedParty array for future use.
- sourceBSS value will be provided as "LIBERATE".
Key Considerations for Cerillion HFC Implementation
- id-uriparam (i.e. WorkOrderId) is mandatory to retrieve the product order details from Cerillion.
- This is implemented for JM market.
- billingAccount.id queryParam (i.e. Billing Account Number) with length 8 is mandatory and it is not validated at Cerillion.
- There is no validation check for workOrderNumber and the response will be provided as per cerillion data availability.
- Based on the project management request, we have included the serviceAddress object in the response. While this approach deviates from TMF standards, it was implemented to minimize effort on the WFM side, allowing them to reuse their existing implementation.
- As the equipId is unique in cerillion, the associated productOrderItems[].id is mapped as per TMFStandards and if productOrder details needs to retrieved for a ProductOrder - productOrderItem[].product.id needs to be considered.
- In cerillion response productCharacteristic[], if isService is true then accessNo will be populated, for isRealEquipment - deviceModelCode, deviceStatus, inventoryCode and for isPackage - packageComponents will be displayed else no fields will be displayed.
- If workOrderStatus is "CU",in response state will be populated as "inProgress, for "CO" compeleted else cancelled.
- geoBlock, networkNodeId, geoCoordinates will not be populated in the response if noInformation found in cerillion for the associated externalUid and networkNodeId.
- channel[] will not be populated in response, if salesChannel is not available in Cerillion.
- productOrderItem[].state is the equipment/product status and state is workOrderStatus.
- sourceBSS value will be provided as "CERILLION".
Cerillion has more address field mappings than compared to Liberate and all those fields don't fit into the serviceAddress. Hence, the fields are concatinated using "|" , so that Cerillion field level identification can be done on each field present in the serviceAddress and below are the ServiceAddress Mappings & its logic.
- addrType - Cerillion(hardcoded value)
- addrLine1 - flatNo | entrace
- addrLine3 - | areaName
- addrLine4 - placeName
- addrLine5 - postCode
Note: If both values in addrLine exists then value will be displayed as - {{value1}} | {{value2}} ,else if any of the value exists then value will be displayed as - | {{value}}, else value will be displayed as "|". This logic is applied for addrLine1, addrLine2, addrLine3.
- addrLine 4, 5 fields will not be populated if placeName and postCode values are not available in cerillion.
URL
https://nonprod.esb.cloud.lla.com/test/wfm-ux/wfm-ux/v1/{businessId}/productOrder/{id}URI Params
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | Y |
| id | string | Unique identifier of the product order | Y |
Headers
| name | type | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | N |
Query Param
| name | type | description | required |
|---|---|---|---|
| billingAccount.id | string | Unique identifier of the billing account | Y |
cURL request for FTTH-Liberate
curl --location 'https://nonprod.esb.cloud.lla.com/test/wfm-ux/wfm-ux/v1/JM/productOrder/FT7327I?billingAccount.id=307583110000' \
--header 'client_id: 123' \
--header 'client_secret: 123' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b'Response for FTTH-Liberate
{
"id": "FT7327I",
"description": "This order has been outstanding for 923 days 12 hrs 50 minsPlease see circulation profile for further detail.",
"completionDate": "2022-09-29T16:42:33.000-05:00",
"expectedCompletionDate": "2022-09-29T16:27:25.000-05:00",
"externalId": "",
"notificationContact": "876",
"orderDate": "2022-09-29T16:27:25.000-05:00",
"priority": "1",
"requestedCompletionDate": "1858-11-17T00:00:00.000-05:07",
"requestedStartDate": "2022-09-29T16:27:25.000-05:00",
"billingAccount": {
"id": "307583110000",
"name": "MS SHADA SIPMSON"
},
"channel": [
{
"id": "M",
"role": "Used channel for order capture",
"name": "By Mail"
}
],
"productOrderItem": [
{
"id": "50510",
"quantity": 1,
"state": "X",
"product": {
"startDate": "2022-02-25T08:29:56.000-05:00",
"terminationDate": "2022-11-30T09:54:00.000-05:00",
"orderDate": "2022-11-30T09:55:33.000-05:00",
"description": "Mobile",
"productCharacteristic": [
{
"name": "commandId",
"valueType": "string",
"value": "CCL"
},
{
"name": "servType",
"valueType": "string",
"value": "CE"
},
{
"name": "uniqueServId",
"valueType": "string",
"value": "71296449"
},
{
"name": "custProdNo",
"valueType": "string",
"value": "408677537"
},
{
"name": "lineNo",
"valueType": "string",
"value": "1"
}
],
"itemPrice": {
"productOfferingPrice": {
"id": "7",
"@referredType": "priceVarCode"
}
},
"productSpecification": {
"id": "50510",
"name": "GSM Postpaid Primary Product (Access)",
"description": "GSM Postpaid Primary Product (Access)",
"orderDate": "",
"productSerialNumber": "8765180358",
"startDate": "",
"terminationDate": ""
},
"realizingResource": [
{
"id": "8765180358",
"name": "msisdn"
}
]
}
},
{
"id": "50566",
"quantity": 1,
"state": "X",
"product": {
"startDate": "2022-02-25T08:29:56.000-05:00",
"terminationDate": "2022-11-30T09:54:00.000-05:00",
"orderDate": "2022-11-30T09:55:33.000-05:00",
"description": "Mobile",
"productCharacteristic": [
{
"name": "commandId",
"valueType": "string",
"value": "CGF"
},
{
"name": "servType",
"valueType": "string",
"value": "CE"
},
{
"name": "uniqueServId",
"valueType": "string",
"value": "71296449"
},
{
"name": "custProdNo",
"valueType": "string",
"value": "114496077"
},
{
"name": "lineNo",
"valueType": "string",
"value": "2"
}
],
"productSpecification": {
"id": "50566",
"name": "Call Waiting",
"description": "Call Waiting",
"orderDate": "",
"productSerialNumber": "8765180358",
"startDate": "",
"terminationDate": ""
},
"realizingResource": [
{
"id": "8765180358",
"name": "msisdn"
}
]
}
}
],
"orderCharacteristics": {
"siteCode": "CAC",
"depttCode": "ECCB",
"exchangeId": "GSMX"
},
"place": [
{
"id": "CAC",
"role": "site"
},
{
"id": "GSMX",
"role": "exchange"
},
{
"id": "ADGF",
"role": "geoBlock"
}
],
"serviceAddress": {
"addrType": "A",
"addrLine1": "Lot 812 11 Barracuda Way, Breaton",
"addrLine2": "Greater Portmore P.O",
"addrLine3": "St. Catherine",
"addrLine4": "Jamaica"
},
"relatedParty": [
{
"id": "22042",
"name": "Joseph WELSH",
"role": "J WELSH",
"@referredType": "Individual"
},
{
"id": "ECCB",
"role": "Department",
"@referredType": "Company"
}
],
"state": "A",
"@type": "ProductOrder",
"sourceBSS": "LIBERATE"
}cURL request for HFC-Cerillion
curl --location 'https://nonprod.esb.cloud.lla.com/test/wfm-ux/wfm-ux/v1/JM/productOrder/3994236?billingAccount.id=50281712' \
--header 'client_id: 123' \
--header 'client_secret: 123' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b'Response for HFC-cerillion
{
"id": "3994236",
"completionDate": "2018-09-06T00:00:00.000-04:00",
"expectedCompletionDate": "2018-09-06T00:00:00.000-04:00",
"externalId": "2142491",
"orderDate": "2018-09-06T00:00:00.000-04:00",
"requestedCompletionDate": "2018-09-06T00:00:00.000-04:00",
"requestedStartDate": "2018-09-06T00:00:00.000-04:00",
"billingAccount": {
"id": "50281712",
"name": "NORVIA TOMLINSON"
},
"channel": [
{
"id": "OnlineChannel",
"name": "OnlineChannel"
}
],
"productOrderItem": [
{
"id": "8139934",
"state": "RE",
"action": "noChange",
"product": {
"id": "RSPBDESS",
"description": "Internet Essential (200/50 Mbps)",
"productSerialNumber": "H40CW0288000",
"productCharacteristic": [
{
"name": "isService",
"valueType": "boolean",
"value": true
},
{
"name": "accesNo",
"valueType": "string",
"value": "01336495"
},
{
"name": "isRealEquipment",
"valueType": "boolean",
"value": true
},
{
"name": "deviceModelCode",
"valueType": "string",
"value": "concax"
},
{
"name": "deviceStatus",
"valueType": "string",
"value": "ONACCOUNT"
},
{
"name": "inventoryCode",
"valueType": "string",
"value": "ABGJIOOP"
},
{
"name": "isPackage",
"valueType": "boolean",
"value": true
},
{
"name": "packageComponents",
"valueType": "array",
"value": [
{
"equipId": "8139932",
"productCode": "RSDBDESS",
"productDescription": "Internet Essential (200/50 Mbps)",
"isService": true,
"accessNo": "DV0001336495",
"isRealEquipment": true,
"deviceModelCode": "Conax",
"deviceStatus": "disconnect",
"inventoryCode": "hjoumm",
"isPackage": false,
"serialNumber": "H40CW0288000"
}
]
}
]
}
},
{
"id": "8157305",
"state": "RE",
"action": "noChange",
"product": {
"id": "RSPTHPBF",
"description": "Home Phone Basic",
"productSerialNumber": "",
"productCharacteristic": [
{
"name": "isService",
"valueType": "boolean",
"value": true
},
{
"name": "accesNo",
"valueType": "string",
"value": "01336495"
},
{
"name": "isRealEquipment",
"valueType": "boolean",
"value": false
},
{
"name": "isPackage",
"valueType": "boolean",
"value": true
},
{
"name": "packageComponents",
"valueType": "array",
"value": [
{
"equipId": "8157304",
"productCode": "RSTTHPBF",
"productDescription": "Home Phone Basic",
"isService": true,
"accessNo": "8766154774",
"isRealEquipment": false,
"isPackage": false
}
]
}
]
}
},
{
"id": "8188626",
"state": "RE",
"action": "noChange",
"product": {
"id": "RSHWASTR",
"description": "[AVS] TV Essential",
"productSerialNumber": "",
"productCharacteristic": [
{
"name": "isService",
"valueType": "boolean",
"value": false
},
{
"name": "isRealEquipment",
"valueType": "boolean",
"value": true
},
{
"name": "deviceModelCode",
"valueType": "string",
"value": "Conax"
},
{
"name": "deviceStatus",
"valueType": "string",
"value": "DISCONNECT"
},
{
"name": "inventoryCode",
"valueType": "string",
"value": "ATSUBPREM"
},
{
"name": "isPackage",
"valueType": "boolean",
"value": true
},
{
"name": "packageComponents",
"valueType": "array",
"value": [
{
"equipId": "8188623",
"productCode": "RSJHIDCF",
"productDescription": "Digital Control Fee",
"isService": false,
"isRealEquipment": false,
"isPackage": false
},
{
"equipId": "8188624",
"productCode": "RSJHSTRT",
"productDescription": "[AVS] TV Essential",
"isService": true,
"accessNo": "DV0001336495",
"isRealEquipment": false,
"isPackage": false
},
{
"equipId": "8188625",
"productCode": "RSJPVR01",
"productDescription": "5Hrs Free Cloud Video Recording",
"isService": false,
"isRealEquipment": false,
"isPackage": false
}
]
}
]
}
},
{
"id": "8188629",
"state": "RE",
"action": "noChange",
"product": {
"id": "RSJHRF01",
"description": "AVS Set-Top Box Rental",
"productSerialNumber": "",
"productCharacteristic": [
{
"name": "isService",
"valueType": "boolean",
"value": false
},
{
"name": "isRealEquipment",
"valueType": "boolean",
"value": false
},
{
"name": "isPackage",
"valueType": "boolean",
"value": false
}
]
}
}
],
"serviceAddress": {
"addrType": "Cerillion",
"addrLine1": "TH 1 | ROMANCS RIVIERA",
"addrLine2": "4 | WIMPLEWOODS CLOSE",
"addrLine3": "| DECARTERET",
"addrLine4": "MANDEVILLE",
"addrLine5": "00000"
},
"relatedParty": [
{
"id": "CB002",
"name": "123",
"role": "Seller",
"@referredType": "Individual"
}
],
"place": [
{
"id": "66° 78 88.4 N",
"role": "geoCoordinates",
"name": "X"
},
{
"id": "60° 39 49 E",
"role": "geoCoordinates",
"name": "Y"
},
{
"id": "MOBAY EST",
"role": "geoBlock",
"name": "GeographicalLocation"
},
{
"id": "JM-04-25",
"role": "networkNodeId",
"name": "Exchange"
}
],
"state": "completed",
"@type": "ProductOrder",
"sourceBSS": "CERILLION"
}